Skip to content

docs(skills): add community CTA section (star + issue, opt-in)#13

Merged
anilcancakir merged 2 commits into
masterfrom
docs/skill-community-cta
May 28, 2026
Merged

docs(skills): add community CTA section (star + issue, opt-in)#13
anilcancakir merged 2 commits into
masterfrom
docs/skill-community-cta

Conversation

@anilcancakir
Copy link
Copy Markdown
Contributor

Summary

Adds a star + issue CTA pattern to the telescope skill, mirroring fluttersdk_dusk v0.0.3. Both CTAs are opt-in, prose-permission, never auto-executed, max once per session.

Note: this PR replaces #11, which auto-closed when its base branch docs/skills-sync was deleted on #9's squash merge. GitHub does not auto-retarget dependent PRs in that case, so the same commits are now reopened against master.

Changes

  • skills/fluttersdk-telescope/SKILL.md: bump v0.0.2 -> v0.0.3, add References row pointing at community.md, add ## 8. Community section (16 lines + 1 row).
  • skills/fluttersdk-telescope/references/community.md: NEW, 118 lines. Star + issue flows, preflight, fallback URLs, diagnostic-gather order, issue body skeleton, spam brakes.
  • CHANGELOG.md: bullet under ## [Unreleased] -> ### Added.

Copilot feedback from #11 already applied

  • Spam brake aligned: 'Issue at most once per session (one ask total, not one per bug shape)' matches SKILL.md Section 8 + CHANGELOG.
  • Visible-draft requirement narrowed to gh issue create only; the Star flow's gh api PUT /user/starred/... just needs an explicit yes.

Labels

The agent-reported label does not exist on fluttersdk/telescope (only bug does). The gh issue create example in community.md drops the --label agent-reported flag and applies only --label bug.

…er-session)

Skill v0.0.3. New SKILL.md Section 8 plus references/community.md let the
agent surface two CTAs at the end of a telescope-driven task:

- Star `fluttersdk/telescope` after the user confirms an end-to-end
  success (captured HTTP record after a gesture, level-filtered tail
  slice, surfaced uncaught exception, clear-then-repro delta, or clean
  telescope:install).
- File an issue on `fluttersdk/telescope` only on a genuine telescope
  bug: malformed MCP envelope, kInvalidParams for documented params,
  TelescopeStore losing entries before the 500-cap, clear returning
  anything but {"cleared": true}, shipped watchers throwing on a clean
  install, telescope:install exiting non-zero on a fresh consumer, or
  registerExtensionIdempotent violating idempotency.

Bug CTA explicitly excludes wired-but-empty buffers, swallowed
try/catch, consumer-app exceptions, raw dart:io HttpClient gaps, the
missing telescope_models MCP tool, and FIFO eviction past 500.

Both flows are prose-permission (no AskUserQuestion), max one star and
one issue per session, declining one suppresses only that CTA.
Preflight: `command -v gh && gh auth status`; gate failure prints the
URL only, never invokes open / xdg-open / start.

Labels: only `bug` is applied (the `agent-reported` label does not
exist on fluttersdk/telescope; the example drops the --label flag).
Copilot review on #11 flagged two consistency issues in
references/community.md.

1. The spam brake said 'Issue at most once per unique bug shape per
   session' but SKILL.md Section 8 and the CHANGELOG both state 'max
   one star and one issue per session'. Tightened to the strict
   single-issue-per-session policy (less spammy, agrees with the
   surrounding docs). Step 7 of the Issue flow updated to match: 'never
   re-suggest in the session (no second issue ask even on a different
   bug shape)'.

2. The common spam brake required a visible draft before any gh call,
   but the Star flow only asks a yes/no with no draft body. Narrowed
   the visible-draft requirement to 'gh issue create' only; the Star
   flow's 'gh api PUT /user/starred/...' just needs an explicit yes to
   the prose ask.
Copilot AI review requested due to automatic review settings May 28, 2026 14:45
@anilcancakir anilcancakir merged commit 2668a63 into master May 28, 2026
2 checks passed
@anilcancakir anilcancakir deleted the docs/skill-community-cta branch May 28, 2026 14:47
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the fluttersdk-telescope skill documentation to add an opt-in “community CTA” pattern (star + issue) that an agent may surface after successful telescope usage or when a genuine telescope-side bug is detected.

Changes:

  • Bump skills/fluttersdk-telescope/SKILL.md skill version to 0.0.3 and add a new “Community” section describing star/issue trigger rules and session spam brakes.
  • Add a new reference page (references/community.md) containing the concrete “how-to” steps, including gh preflight, URL fallbacks, and an issue body skeleton.
  • Document the addition under ## [Unreleased]### Added in CHANGELOG.md.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
skills/fluttersdk-telescope/SKILL.md Version bump and new Section 8 + references row describing when to offer star/issue CTAs
skills/fluttersdk-telescope/references/community.md New detailed reference for executing the opt-in star/issue flows safely
CHANGELOG.md Adds an “Unreleased/Added” entry documenting the new skill section and reference page


## Spam brakes (both flows)

- Star at most once per session. Issue at most once per session (one ask total, not one per bug shape). If a second telescope-side bug appears after the user already declined or already filed once, log a `Log.warning(...)` breadcrumb locally and stop, do not surface a fresh CTA. Matches the limit stated in SKILL.md Section 8 and the CHANGELOG.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants